Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): added missing props translations #3367

Merged
merged 50 commits into from
May 26, 2023

Conversation

xiongmao86
Copy link
Contributor

@xiongmao86 xiongmao86 commented Apr 24, 2023

Try to fix #2095.

Description

waiting for file of VaFileUpload

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Improvement/refactoring (non-breaking change that doesn't add any feature but make things better)

@xiongmao86
Copy link
Contributor Author

Hi, I am filling prop descriptions, I meet contain in VaCarousel, I have difficulty figure out what it means, I have search the whole project with contain keyword, but could not find similar component use it, and no similar props in en.json.

What does this prop do?

@xiongmao86 xiongmao86 force-pushed the fix/missing-props-description branch from 8e66ba7 to 0ae25c9 Compare April 24, 2023 08:07
@xiongmao86
Copy link
Contributor Author

Oh, It's in the VaImage component. I neglect to check that. Sorry.

@xiongmao86
Copy link
Contributor Author

Adding aria-select-all-rows-label to VaDataTable emit an 500 error Body is unusable. I don't know how to handle this. Can I have review now and postpone the rest work?

@m0ksem
Copy link
Collaborator

m0ksem commented Apr 28, 2023

Hi, I am filling prop descriptions, I meet contain in VaCarousel, I have difficulty figure out what it means, I have search the whole project with contain keyword, but could not find similar component use it, and no similar props in en.json.

What does this prop do?

Looks like contain is an old prop used and fit="contain" must be used instead. This prop can be removed in 1.7.0, but not now for compatibility support with old versions. Would be nice to hide this prop from docs.

@xiongmao86
Copy link
Contributor Author

Hi, @m0ksem, thanks for taking the review. As you said contain is likely to be deprecated, how can I hide it, do you mean remove it from the en.json file?

@m0ksem
Copy link
Collaborator

m0ksem commented Apr 28, 2023

Adding aria-select-all-rows-label to VaDataTable emit an 500 error Body is unusable. I don't know how to handle this. Can I have review now and postpone the rest work?

Can you push changes, so I can take a look? I'm not understanding the issue...

@m0ksem
Copy link
Collaborator

m0ksem commented Apr 28, 2023

Hi, @m0ksem, thanks for taking the review. As you said contain is likely to be deprecated, how can I hide it, do you mean remove it from the en.json file?

Can be made in api-options.ts file

export default defineManualApi({
  props: {
    contain: {
      hidden: true,
    }
  },
  // ...
});

Copy link
Collaborator

@m0ksem m0ksem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Looks good for me.

@m0ksem m0ksem requested a review from RVitaly1978 April 28, 2023 10:55
@xiongmao86
Copy link
Contributor Author

Adding aria-select-all-rows-label to VaDataTable emit an 500 error Body is unusable. I don't know how to handle this. Can I have review now and postpone the rest work?

Can you push changes, so I can take a look? I'm not understanding the issue...

Thank you very much, I'll put it in a new issue.

@xiongmao86
Copy link
Contributor Author

xiongmao86 commented Apr 28, 2023

@m0ksem, the issue disappear when I save the edit and then yarn serve:docs, it's a work around. I am very sorry for the inconvenient I cause. Should I report an issue? Is appropriate to continue the review and I'll put the rest work on another pr? Or should I continue in the current pr?

@xiongmao86
Copy link
Contributor Author

This pr is ready for review, thanks.

@xiongmao86 xiongmao86 marked this pull request as ready for review May 18, 2023 13:03
@m0ksem m0ksem requested review from misterpekert and removed request for RVitaly1978 May 23, 2023 16:45
@m0ksem
Copy link
Collaborator

m0ksem commented May 25, 2023

Hi, @m0ksem, I have been working on the FileUpload ui component, I have found this file prop, It seems belong to the item of vaFileUploadList, but not VaFileUploadList itself. I wonder why it's exposed at FileUpload component? What does it use for?

Hi. It is exposed trough const VaFileUploadListProps = extractComponentProps(VaFileUploadList). So VaFileUpload inherit props from VaFileUploadList.

@m0ksem m0ksem added the BUG Something isn't working label May 26, 2023
@m0ksem
Copy link
Collaborator

m0ksem commented May 26, 2023

Good work, thanks!

@m0ksem m0ksem changed the title Filling missing prop descriptions chore(docs): added missing props translations May 26, 2023
@m0ksem m0ksem merged commit 23c82f5 into epicmaxco:develop May 26, 2023
@xiongmao86
Copy link
Contributor Author

xiongmao86 commented May 26, 2023

Hi, @m0ksem, I have been working on the FileUpload ui component, I have found this file prop, It seems belong to the item of vaFileUploadList, but not VaFileUploadList itself. I wonder why it's exposed at FileUpload component? What does it use for?

Hi. It is exposed trough const VaFileUploadListProps = extractComponentProps(VaFileUploadList). So VaFileUpload inherit props from VaFileUploadList.

Ah, What I mean is there are files prop, and file prop, files prop is relate to the VaFileUploadList, it represents files to be uploaded. file prop is related to one item of VaUploadFileList, for example it could be an VaFileGalleryItem, that's only one file.

It's strange to have the file prop when files prop is already there. And pointing to item probably means it should be the prop of the specific item it binds to, and shouldn't be exposed as an a prop even in VaFileUploadList.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BUG Something isn't working docs packages/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add missing props description
2 participants